<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: Ipopt::Measurement Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.12</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classIpopt_1_1Measurement.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classIpopt_1_1Measurement-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Ipopt::Measurement Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="SensMeasurement_8hpp_source.html">SensMeasurement.hpp</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Ipopt::Measurement:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classIpopt_1_1Measurement__inherit__graph.png" border="0" usemap="#Ipopt_1_1Measurement_inherit__map" alt="Inheritance graph"/></div>
<map name="Ipopt_1_1Measurement_inherit__map" id="Ipopt_1_1Measurement_inherit__map">
<area shape="rect" title=" " alt="" coords="36,80,189,107"/>
<area shape="rect" href="classIpopt_1_1MetadataMeasurement.html" title=" " alt="" coords="5,155,220,181"/>
<area shape="rect" href="classIpopt_1_1ReferencedObject.html" title="Storing the reference count of all the smart pointers that currently reference it." alt="" coords="23,5,202,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5dc3d2831da73034aed6fb1d89d86c3e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1Measurement.html#a5dc3d2831da73034aed6fb1d89d86c3e">Measurement</a> ()</td></tr>
<tr class="memdesc:a5dc3d2831da73034aed6fb1d89d86c3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class provides an abstraction for the measurements of the states coming in and the solutions of the controller.  <a href="classIpopt_1_1Measurement.html#a5dc3d2831da73034aed6fb1d89d86c3e">More...</a><br /></td></tr>
<tr class="separator:a5dc3d2831da73034aed6fb1d89d86c3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cb0f98dc02647c2b16bf73e5bb166bb"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1Measurement.html#a4cb0f98dc02647c2b16bf73e5bb166bb">~Measurement</a> ()</td></tr>
<tr class="separator:a4cb0f98dc02647c2b16bf73e5bb166bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a703cf5c06d6b97a075cb810782d10fb6"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; <a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1Measurement.html#a703cf5c06d6b97a075cb810782d10fb6">GetInitialEqConstraints</a> ()=0</td></tr>
<tr class="memdesc:a703cf5c06d6b97a075cb810782d10fb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns a std::vector holding the indices in <a class="el" href="classIpopt_1_1IteratesVector.html" title="Specialized CompoundVector class specifically for the algorithm iterates.">IteratesVector</a> of the equations that are to be "slacked" to free the initial values for sIPOPT.  <a href="classIpopt_1_1Measurement.html#a703cf5c06d6b97a075cb810782d10fb6">More...</a><br /></td></tr>
<tr class="separator:a703cf5c06d6b97a075cb810782d10fb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a41f780d9543ae951186222ef060379"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classIpopt_1_1SmartPtr.html">SmartPtr</a>&lt; <a class="el" href="classIpopt_1_1DenseVector.html">DenseVector</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1Measurement.html#a7a41f780d9543ae951186222ef060379">GetMeasurement</a> (<a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> measurement_number)=0</td></tr>
<tr class="memdesc:a7a41f780d9543ae951186222ef060379"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns delta_u.  <a href="classIpopt_1_1Measurement.html#a7a41f780d9543ae951186222ef060379">More...</a><br /></td></tr>
<tr class="separator:a7a41f780d9543ae951186222ef060379"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a738d5f75880c737fcf371bd354cb2196"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1Measurement.html#a738d5f75880c737fcf371bd354cb2196">SetSolution</a> (<a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> measurement_number, <a class="el" href="classIpopt_1_1SmartPtr.html">SmartPtr</a>&lt; <a class="el" href="classIpopt_1_1IteratesVector.html">IteratesVector</a> &gt; sol)=0</td></tr>
<tr class="memdesc:a738d5f75880c737fcf371bd354cb2196"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function does whatever the measurement machine does with the solution of the <a class="el" href="classIpopt_1_1SensAlgorithm.html" title="This is the interface for the actual controller.">SensAlgorithm</a>.  <a href="classIpopt_1_1Measurement.html#a738d5f75880c737fcf371bd354cb2196">More...</a><br /></td></tr>
<tr class="separator:a738d5f75880c737fcf371bd354cb2196"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classIpopt_1_1ReferencedObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classIpopt_1_1ReferencedObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classIpopt_1_1ReferencedObject.html">Ipopt::ReferencedObject</a></td></tr>
<tr class="memitem:a5c0f2208e3ead22bf7c5179381ed8203 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#a5c0f2208e3ead22bf7c5179381ed8203">ReferencedObject</a> ()</td></tr>
<tr class="separator:a5c0f2208e3ead22bf7c5179381ed8203 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbbf3aa5307da62ab8224ba599d4bd7a inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#adbbf3aa5307da62ab8224ba599d4bd7a">~ReferencedObject</a> ()</td></tr>
<tr class="separator:adbbf3aa5307da62ab8224ba599d4bd7a inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac517534e10e36c946aeefc6fe337777 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#aac517534e10e36c946aeefc6fe337777">ReferenceCount</a> () const</td></tr>
<tr class="separator:aac517534e10e36c946aeefc6fe337777 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa69ecb0f026bd741e2fa84c31d4ec332 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#aa69ecb0f026bd741e2fa84c31d4ec332">AddRef</a> (const <a class="el" href="classIpopt_1_1Referencer.html">Referencer</a> *referencer) const</td></tr>
<tr class="separator:aa69ecb0f026bd741e2fa84c31d4ec332 inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6c952e7d1a63080dc8f121c008944fc inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIpopt_1_1ReferencedObject.html#ae6c952e7d1a63080dc8f121c008944fc">ReleaseRef</a> (const <a class="el" href="classIpopt_1_1Referencer.html">Referencer</a> *referencer) const</td></tr>
<tr class="separator:ae6c952e7d1a63080dc8f121c008944fc inherit pub_methods_classIpopt_1_1ReferencedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="SensMeasurement_8hpp_source.html#l00017">17</a> of file <a class="el" href="SensMeasurement_8hpp_source.html">SensMeasurement.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5dc3d2831da73034aed6fb1d89d86c3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dc3d2831da73034aed6fb1d89d86c3e">&#9670;&nbsp;</a></span>Measurement()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Ipopt::Measurement::Measurement </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This class provides an abstraction for the measurements of the states coming in and the solutions of the controller. </p>
<p>It basically acts as the "plant" of the controller. </p>

<p class="definition">Definition at line <a class="el" href="SensMeasurement_8hpp_source.html#l00026">26</a> of file <a class="el" href="SensMeasurement_8hpp_source.html">SensMeasurement.hpp</a>.</p>

</div>
</div>
<a id="a4cb0f98dc02647c2b16bf73e5bb166bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cb0f98dc02647c2b16bf73e5bb166bb">&#9670;&nbsp;</a></span>~Measurement()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual Ipopt::Measurement::~Measurement </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="SensMeasurement_8hpp_source.html#l00029">29</a> of file <a class="el" href="SensMeasurement_8hpp_source.html">SensMeasurement.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a703cf5c06d6b97a075cb810782d10fb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a703cf5c06d6b97a075cb810782d10fb6">&#9670;&nbsp;</a></span>GetInitialEqConstraints()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::vector&lt;<a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>&gt; Ipopt::Measurement::GetInitialEqConstraints </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function returns a std::vector holding the indices in <a class="el" href="classIpopt_1_1IteratesVector.html" title="Specialized CompoundVector class specifically for the algorithm iterates.">IteratesVector</a> of the equations that are to be "slacked" to free the initial values for sIPOPT. </p>
<p>This std::vector is used in the construction of the A-SchurData for the Schur Decomposition. </p>

<p>Implemented in <a class="el" href="classIpopt_1_1MetadataMeasurement.html#a94cc5aa9330c165f7547b9a200f4d666">Ipopt::MetadataMeasurement</a>.</p>

</div>
</div>
<a id="a7a41f780d9543ae951186222ef060379"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a41f780d9543ae951186222ef060379">&#9670;&nbsp;</a></span>GetMeasurement()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classIpopt_1_1SmartPtr.html">SmartPtr</a>&lt;<a class="el" href="classIpopt_1_1DenseVector.html">DenseVector</a>&gt; Ipopt::Measurement::GetMeasurement </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>&#160;</td>
          <td class="paramname"><em>measurement_number</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function returns delta_u. </p>
<p>It should use the values of IpData().trial()-&gt;x() </p>

<p>Implemented in <a class="el" href="classIpopt_1_1MetadataMeasurement.html#af9ea22957b579e9cf66807cba2b4b4b7">Ipopt::MetadataMeasurement</a>.</p>

</div>
</div>
<a id="a738d5f75880c737fcf371bd354cb2196"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a738d5f75880c737fcf371bd354cb2196">&#9670;&nbsp;</a></span>SetSolution()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Ipopt::Measurement::SetSolution </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>&#160;</td>
          <td class="paramname"><em>measurement_number</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classIpopt_1_1SmartPtr.html">SmartPtr</a>&lt; <a class="el" href="classIpopt_1_1IteratesVector.html">IteratesVector</a> &gt;&#160;</td>
          <td class="paramname"><em>sol</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function does whatever the measurement machine does with the solution of the <a class="el" href="classIpopt_1_1SensAlgorithm.html" title="This is the interface for the actual controller.">SensAlgorithm</a>. </p>

<p>Implemented in <a class="el" href="classIpopt_1_1MetadataMeasurement.html#aa896d7aa9cdd02a9de62210c0def0ea0">Ipopt::MetadataMeasurement</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/sIPOPT/src/<a class="el" href="SensMeasurement_8hpp_source.html">SensMeasurement.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
